CORS-4157: AWS, Azure: Add IPFamily to the PlatformStatus within Infra CR #2499

sadasu · 2025-09-23T21:30:22Z

Add a new field IPFamily to AWS and Azure PlatformStatus to indicate the IPFamily configured by the user for that cluster install.
IPFamily can be set to IPv4, DualIPv6Primary and DualIPv4Primary
This capability is currently behind feature gates that were added in CORS-4136: Add Feature gates for AWS, Azure and GCP Dual Stack support #2430.
Augmented tests for these new fields.

openshift-ci-robot · 2025-09-23T21:30:26Z

@sadasu: This pull request references CORS-4157 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.21.0" version, but no target version was set.

In response to this:

Add a new field IPFamily to AWS and Azure PlatformStatus to indicate the IPFamily configured by the user for that cluster install.

IPFamily can be set to IPv4, DualIPv6Primary and DualIPv4Primary

This capability is currently behind feature gates that were added in CORS-4136: Add Feature gates for AWS, Azure and GCP Dual Stack support #2430.

Augmented tests for these new fields.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci · 2025-09-23T21:30:29Z

Hello @sadasu! Some important instructions when contributing to openshift/api:
API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

JoelSpeed · 2025-09-24T10:22:33Z

config/v1/types_infrastructure.go


+// IPFamilyType represents the IP protocol family that cloud platform resources should use.
+// +kubebuilder:validation:Enum=IPv4;DualIPv6Primary;DualIPv4Primary
+// +kubebuilder:validation:XValidation:rule="self in ['IPv4', 'DualIPv6Primary', 'DualIPv4Primary']",message="ipFamily must be one of: IPv4, DualIPv6Primary, DualIPv4Primary"


The enum should cover this, so I don't think we need this CEL too

Yeah, removed that.

JoelSpeed · 2025-09-24T10:23:03Z

config/v1/types_infrastructure.go

+	// IPv4 indicates that cloud platform resources should use IPv4 addressing only.
+	IPv4 IPFamilyType = "IPv4"
+
+	// DualIPv6Primary indicates that cloud platform resources should use dual-stack networking with IPv6 as primary.


Do we want to call this DualStackIPv6Primary? I figure we often call it DualStack in other places so omitting Stack here might be confusing?

Changed to DualStackIPv*Primary

JoelSpeed · 2025-09-24T10:25:07Z

config/v1/types_infrastructure.go

+	//
+	// +default="IPv4"
+	// +kubebuilder:default="IPv4"
+	// +kubebuilder:validation:XValidation:rule="oldSelf == '' || self == oldSelf",message="ipFamily is immutable once set"


Can you try this instead? I think this will be more robust

Suggested change

// +kubebuilder:validation:XValidation:rule="oldSelf == '' || self == oldSelf",message="ipFamily is immutable once set"

// +kubebuilder:validation:XValidation:rule="!oldSelf.hasValue() || self == oldSelf",message="ipFamily is immutable once set",optionalOldSelf=true

When I tried this make verify complains with:

error running generator schemacheck on group config.openshift.io: could not run schemacheck generator for group/version config.openshift.io/v1: MustNotExceedCostBudget: ^.properties[status].properties[platformStatus].properties[azure].properties[ipFamily]: Invalid value: {"Rule":"!oldSelf.hasValue() || self == oldSelf","Message":"ipFamily is immutable once set","MessageExpression":"","Reason":null,"FieldPath":"","OptionalOldSelf":true}: compilation failed: ERROR: <input>:1:29: found no matching overload for '_==_' applied to '(string, optional_type(string))' | !oldSelf.hasValue() || self == oldSelf | ............................^

Apologies, should be

Suggested change

// +kubebuilder:validation:XValidation:rule="oldSelf == '' || self == oldSelf",message="ipFamily is immutable once set"

// +kubebuilder:validation:XValidation:rule="!oldSelf.hasValue() || self == oldSelf.value()",message="ipFamily is immutable once set",optionalOldSelf=true

JoelSpeed · 2025-09-24T10:26:20Z

config/v1/types_infrastructure.go

+
 // AWSPlatformSpec holds the desired state of the Amazon Web Services infrastructure provider.
 // This only includes fields that can be modified in the cluster.
 type AWSPlatformSpec struct {


Need a CEL rule here to prevent removing ipFamily if it exists

!has(oldSelf.ipFamily) || has(self.ipFamily)

I tried it for Azure here, and found that make verify complained about this:

error running generator schemacheck on group config.openshift.io: could not run schemacheck generator for group/version config.openshift.io/v1: MustNotExceedCostBudget: ^.properties[status].properties[platformStatus].properties[azure]: Invalid value: {"Rule":"!has(oldSelf.ipFamily) \u0026\u0026 !has(self.ipFamily) || has(oldSelf.ipFamily) \u0026\u0026 has(self.ipFamliy)","Message":"ipFamily cannot be removed once set","MessageExpression":"","Reason":null,"FieldPath":"","OptionalOldSelf":null}: compilation failed: ERROR: <input>:1:78: undefined field 'ipFamliy' | !has(oldSelf.ipFamily) && !has(self.ipFamily) || has(oldSelf.ipFamily) && has(self.ipFamliy) | .............................................................................^

You'll need to use a feature gate aware XValidation rule

- The new IPFamily can be set to IPv4, DualStackIPv6Primary or DualStackIPv4Primary. - This capability is currently behind feature gates that were added earlier. - ControllerConfig is also updated because it embeds the Infra object. - Added tests for this new field.

sadasu · 2025-10-14T23:46:44Z

/retest

openshift-ci · 2025-10-15T08:57:06Z

@sadasu: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/okd-scos-e2e-aws-ovn	`fca93af`	link	false	`/test okd-scos-e2e-aws-ovn`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

jhixson74 · 2025-10-15T20:38:02Z

/cc

JoelSpeed · 2025-10-21T11:56:17Z

config/v1/types_infrastructure.go

+	// IPv4-only, or dual-stack networking with IPv4 or IPv6 as the primary
+	// protocol family.
+	//
+	// +default="IPv4"


Remind me why we default this to IPv4? VS leaving it empty on upgrade?

The underlying assumption is that all existing running clusters are IPv4 based. If we leave the default as empty, after an upgrade, someone could actually set the value to DualStackIPv6Primary which is not supported. Setting it explicitly to IPv4 on an upgrade will protect us from this value being changed on upgraded clusters.

JoelSpeed · 2025-10-21T12:01:03Z

config/v1/tests/infrastructures.config.openshift.io/AWSDualStackInstall.yaml

+            aws:
+              region: us-east-1
+            type: AWS
+      expectedStatusError: "status.platformStatus.aws.ipFamily: Invalid value: \"string\": ipFamily is immutable once set"


Oh nice, so is this the optionalOldSelf rule on the field itself triggering here? I guess it's the combination of that rule and the defaulting (which is a change of value)

JoelSpeed · 2025-10-23T11:30:32Z

/lgtm

openshift-ci-robot · 2025-10-23T11:30:59Z

Scheduling tests matching the pipeline_run_if_changed or not excluded by pipeline_skip_if_only_changed parameters:
/test e2e-aws-ovn
/test e2e-aws-ovn-hypershift
/test e2e-aws-ovn-hypershift-conformance
/test e2e-aws-ovn-techpreview
/test e2e-aws-serial-1of2
/test e2e-aws-serial-2of2
/test e2e-aws-serial-techpreview-1of2
/test e2e-aws-serial-techpreview-2of2
/test e2e-azure
/test e2e-gcp
/test e2e-upgrade
/test e2e-upgrade-out-of-change

openshift-ci · 2025-10-23T11:31:02Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JoelSpeed

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [JoelSpeed]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

sadasu · 2025-10-23T16:41:32Z

/verified by @sadasu

openshift-ci-robot · 2025-10-23T16:41:44Z

@sadasu: This PR has been marked as verified by @sadasu.

In response to this:

/verified by @sadasu

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Sep 23, 2025

openshift-ci bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Sep 23, 2025

openshift-ci bot requested review from JoelSpeed and everettraven September 23, 2025 21:30

sadasu force-pushed the aws-azure-gcp-dual-stack branch 5 times, most recently from bffb15b to 29d9d89 Compare September 24, 2025 04:29

JoelSpeed reviewed Sep 24, 2025

View reviewed changes

sadasu force-pushed the aws-azure-gcp-dual-stack branch from 29d9d89 to 2c87771 Compare September 24, 2025 17:35

sadasu force-pushed the aws-azure-gcp-dual-stack branch 2 times, most recently from a7b5164 to c0de8a0 Compare October 8, 2025 15:39

sadasu force-pushed the aws-azure-gcp-dual-stack branch from c0de8a0 to 4ad5ded Compare October 14, 2025 16:07

sadasu force-pushed the aws-azure-gcp-dual-stack branch from 4ad5ded to fca93af Compare October 14, 2025 21:56

openshift-ci bot requested a review from jhixson74 October 15, 2025 20:38

JoelSpeed reviewed Oct 21, 2025

View reviewed changes

openshift-ci bot assigned JoelSpeed Oct 23, 2025

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Oct 23, 2025

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 23, 2025

openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Oct 23, 2025

openshift-merge-bot bot merged commit 8691c30 into openshift:master Oct 23, 2025
27 of 28 checks passed

	// +kubebuilder:validation:XValidation:rule="oldSelf == '' \|\| self == oldSelf",message="ipFamily is immutable once set"
	// +kubebuilder:validation:XValidation:rule="!oldSelf.hasValue() \|\| self == oldSelf",message="ipFamily is immutable once set",optionalOldSelf=true

CORS-4157: AWS, Azure: Add IPFamily to the PlatformStatus within Infra CR #2499

CORS-4157: AWS, Azure: Add IPFamily to the PlatformStatus within Infra CR #2499

Uh oh!

Conversation

sadasu commented Sep 23, 2025

Uh oh!

openshift-ci-robot commented Sep 23, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci bot commented Sep 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sadasu commented Oct 14, 2025

Uh oh!

openshift-ci bot commented Oct 15, 2025

Uh oh!

jhixson74 commented Oct 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sadasu Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JoelSpeed commented Oct 23, 2025

Uh oh!

openshift-ci-robot commented Oct 23, 2025

Uh oh!

openshift-ci bot commented Oct 23, 2025

Uh oh!

sadasu commented Oct 23, 2025

Uh oh!

openshift-ci-robot commented Oct 23, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

openshift-ci-robot commented Sep 23, 2025 •

edited by openshift-ci bot

Loading

sadasu Oct 21, 2025 •

edited

Loading